docs!: add zensical-based docs for the project#8
Merged
Conversation
Note, this is a breaking change because we change the names of the codec classes defined in this repo. The reason for the renaming is to ensure that we can smoothly handle updates to the zarr-python codec API which might be inbound in the next few months. A new codec implementation would get a name ending with a `V2` suffix.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #8 +/- ##
==========================================
+ Coverage 94.07% 99.19% +5.12%
==========================================
Files 8 9 +1
Lines 253 249 -4
==========================================
+ Hits 238 247 +9
+ Misses 15 2 -13 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
This is a big breaking change that improves the project layout.
Collaborator
Author
|
this ballooned in scope and effectively became a nice time to define the public API |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Note, this is a breaking change because we change the names of the codec classes defined in this repo.
The reason for the renaming is to ensure that we can smoothly handle updates to the zarr-python codec API
which might be inbound in the next few months. A new codec implementation would get a name ending with a
V2suffix.